Billing APIs | Equinix Product Documentation

Retrieve billing summary

Request

This method retrieves a summary invoice or credit memo information based on date range, account number or transactions ID for a user with billing viewing permission.

Security

BearerAuth

Query

startDatestring, (date)

Start date of invoice in YYYY-MM-DD format

Example:startDate=2021-09-17

endDatestring, (date)

End date of invoice in YYYY-MM-DD format

Example:endDate=2021-10-17

accountNumbersArray of strings

List of accounts to be filtered

transactionIdsArray of strings

List of transactions to be filtered

offsetinteger, >= 0

Use offset to control the number of records to be skipped in the response.

Default:0

limitinteger, [ 1 .. 200 ]

Use limit to restrict the number of records in the response.

Default:10

Payload

// No request payload

Responses

Ok

Bodyapplication/json

dataArray of objects(invoiceSummaryDetails)

paginationobject(pagination_summary)

Pagination

Response

{
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 3,
    "next": "/invoices?limit=10&offset=0"
  }
}